Cucumber-js: मूल JS मॉड्यूल चरण परिभाषाओं और समर्थन कोड में समर्थन करता है

को निर्मित 3 अप्रैल 2020 · 13टिप्पणियाँ · स्रोत: cucumber/cucumber-js

संकट

जब मैं मूल ईसीएमएस्क्रिप्ट मॉड्यूल में परिभाषित एक चरण परिभाषा के साथ Cucumber.js चलाने का प्रयास करता हूं (जैसा कि यहां दस्तावेज किया गया require() का उपयोग कर रहा हूं।

Cucumber.js संस्करण: 6.0.5
नोड संस्करण: 13.8.0

प्रजनन के चरण

npm init और npm i cucumber का उपयोग करके एक मूल NPM पैकेज निर्देशिका सेटअप करें
- "type": "module" को package.json फ़ाइल में सेट करें ताकि यह सुनिश्चित हो सके कि JS फ़ाइलों को मूल मॉड्यूल के रूप में माना जाएगा

एक बुनियादी सुविधा फ़ाइल बनाएँ, features/mjs.feature :

Feature: Native JS Modules

    Scenario: Load a native JS module step definition
        Given I have 42 cucumbers in my belly

एक मूल चरण परिभाषा फ़ाइल बनाएँ, features/step_definitions.js :

import { Given } from "cucumber";

Given("I have {int} cucumbers in my belly", function (cucumberCount) {
    console.log("Step parsed.");
});

खीरा चलाने का प्रयास:
```
$ ./node_modules/.bin/cucumber-js
```

अपेक्षित परिणाम

चरण परिभाषा मॉड्यूल को लोड किया जाना चाहिए और चरण को पार्स करने के लिए उपयोग किया जाना चाहिए।

वास्तविक परिणाम

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /some/path/cucumbertest/features/step_definitions.js
require() of ES modules is not supported.
require() of /some/path/cucumbertest/features/step_definitions.js from /some/path/cucumbertest/node_modules/cucumber/lib/cli/index.js is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename step_definitions.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /some/path/cucumbertest/package.json.

    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1167:13)
    at Module.load (internal/modules/cjs/loader.js:1000:32)
    at Function.Module._load (internal/modules/cjs/loader.js:899:14)
    at Module.require (internal/modules/cjs/loader.js:1040:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at /some/path/cucumbertest/node_modules/cucumber/lib/cli/index.js:119:42
    at Array.forEach (<anonymous>)
    at Cli.getSupportCodeLibrary (/some/path/cucumbertest/node_modules/cucumber/lib/cli/index.js:119:22)
    at Cli.run (/some/path/cucumbertest/node_modules/cucumber/lib/cli/index.js:141:37)
    at async Object.run [as default] (/some/path/cucumbertest/node_modules/cucumber/lib/cli/run.js:30:14)

समापन

इसके लायक क्या है, मैं वास्तव में उस काम की सराहना करता हूं जो Cucumber.js टीम ने इस परियोजना पर किया है, यह मेरे और मेरी कंपनी के लिए एक प्रमुख संपत्ति रही है। मेरी टीम ने देशी जेएस मॉड्यूल में कुछ साझा एप्लिकेशन घटकों के निर्माण में कुछ समय लगाया है, और हाल ही में जब तक मैं यह नहीं मान रहा था (सबसे वर्तमान दस्तावेज में import सिंटैक्स के आधार पर) कि यह सामान ककड़ी के साथ काम करेगा जब हम हमारे परीक्षण ढांचे के साथ एकीकृत करने के लिए तैयार हो गया। हालांकि ऐसा नहीं लगता है। चूंकि साझा घटक पहले से ही हमारे आवेदन के अन्य भागों में लिखा और एकीकृत है, इसलिए मैं इंटरऑपरेबिलिटी चुनौतियों के कारण कॉमनजेएस में लिखे गए केवल चरण परिभाषाओं और समर्थन कोड का उपयोग करने में अनिच्छुक हूं।

अन्य चीजें जिन्हें मैंने काम पर लाने का प्रयास किया, उनमें शामिल हैं ...

मूल मॉड्यूल फ़ाइलों को .mjs एक्सटेंशन देना, प्रति Node.js सम्मेलन (इससे उन्हें ककड़ी के ऑटो-लोडिंग तर्क द्वारा अनदेखा किया गया, और --require का उपयोग करके चरण परिभाषा मॉड्यूल को स्पष्ट रूप से लोड करने के लिए Error [ERR_REQUIRE_ESM]: Must use import to load ES Module फेंक दिया गया
CJS मॉड्यूल में मूल मॉड्यूल को लपेटना जो गतिशील import() फ़ंक्शन का उपयोग करते हैं; समस्या यह थी कि यह दृष्टिकोण अतुल्यकालिक है, और यहां तक कि अगर आयात वादा सीजेएस मॉड्यूल द्वारा निर्यात किया जाता है, तो ककड़ी आगे बढ़ने से पहले उस वादे को हल करने की प्रतीक्षा नहीं करती है, क्योंकि चरण को अपरिभाषित के रूप में चिह्नित किया गया था (यह सुझाव देते हुए कि चरण परिभाषा देशी मॉड्यूल में अभी तक पंजीकृत नहीं था)।

अगर यह मेरी क्षमता के भीतर है, तो मुझे इस मुद्दे को हल करने में मदद करने के लिए एक पीआर सबमिट करने में खुशी होगी, लेकिन मैं Cucumber.js के आंतरिक कामकाज से अपरिचित हूं और अगर कोई मुझे सही दिशा में इंगित कर सकता है तो मैं इसकी सराहना करूंगा।

accepted enhancement

स्रोत

adamlacoste

👍6

सबसे उपयोगी टिप्पणी

मैं .js एक्सटेंशन और "type":"module" हूं क्योंकि मुझे उम्मीद है कि यह लंबी अवधि में आदर्श बन जाएगा।

looeee 28 फ़र॰ 2021

👍3

सभी 13 टिप्पणियाँ

मैं ईएसएम के साथ काम कर रहे ककड़ी-जेएस प्राप्त करना चाहता हूं। हमारे पास इसके बारे में कुछ अन्य मुद्दे पहले ही खुल चुके थे।

हम एक सीएलआई विकल्प बना सकते हैं (या यह देखने के लिए किसी अन्य तरीके का उपयोग करें कि इसे कब इस्तेमाल किया जाए) जो ककड़ी-जेएस को आवश्यकता के बजाय import उपयोग करता है और लौटाए गए वादे पर प्रतीक्षा करता है।

आपके द्वारा जोड़े गए उदाहरण को देखते हुए, हम विशेष रूप से इसके लिए एक परीक्षण केस जोड़ सकते हैं और इसे पास करने पर काम कर सकते हैं। स्विचिंग के साथ प्रयोग करने के लिए आयात करने और उस वादे पर प्रतीक्षा करने की आवश्यकता होती है, जिसके बाद मैं एक और त्रुटि में भाग गया:

⋊> ~/p/test ./node_modules/.bin/cucumber-js                                21:05:22
(node:7422) ExperimentalWarning: The ESM module loader is experimental.
file:///test/features/steps.js:1
import { Given } from "cucumber";
         ^^^^^
SyntaxError: The requested module 'cucumber' does not provide an export named 'Given'
    at ModuleJob._instantiate (internal/modules/esm/module_job.js:92:21)
    at async ModuleJob.run (internal/modules/esm/module_job.js:107:20)
    at async Loader.import (internal/modules/esm/loader.js:176:24)
    at async Promise.all (index 0)
    at async Cli.getSupportCodeLibrary (/test/node_modules/cucumber/lib/cli/index.js:119:5)
    at async Cli.run (/test/node_modules/cucumber/lib/cli/index.js:141:32)
    at async Object.run [as default] (/test/node_modules/cucumber/lib/cli/run.js:30:14)

charlierudolph 9 अप्रैल 2020

मैंने चरण परिभाषा दस्तावेज़ीकरण से उदाहरण (थोड़ा संशोधित) लिया, लेकिन आप सही हैं, यह लिखित रूप में काम नहीं करेगा। क्योंकि Cucumber.js एक CommonJS मॉड्यूल है, यह केवल एक डिफ़ॉल्ट निर्यात प्रदान करता है। अल्पावधि में, मैं शायद केवल मॉड्यूल डिफ़ॉल्ट आयात करूंगा और उसके बाद दिए गए/कब/फिर विधियों तक पहुंच प्राप्त करूंगा:

import cucumber from "cucumber";

cucumber.Given(...);

लंबे समय तक, यह अच्छा होगा यदि ककड़ी के आयात और आवश्यकता के लिए अलग-अलग प्रवेश बिंदु हों, जैसा कि यहां दिखाया गया

इसे देखने के लिए धन्यवाद। इसके लायक क्या है, आवश्यकता के बजाय ककड़ी को आयात करने के लिए कहने के लिए एक सीएलआई विकल्प मुझे ठीक लगेगा। यह भी बहुत अच्छा होगा यदि ककड़ी .cjs और .mjs एक्सटेंशन वाली समर्थन फ़ाइलों की तलाश करेगी, और स्वचालित रूप से उन्हें क्रमशः CommonJS और मूल मॉड्यूल के रूप में मानेगी।

संपादित करें: बस यह दोहराना चाहता हूं कि अगर मैं कर सकता हूं तो मुझे इसमें से किसी की भी मदद करने में खुशी होगी; बस मुझे सही दिशा में इंगित करें।

adamlacoste 9 अप्रैल 2020

मैं शायद केवल मॉड्यूल डिफ़ॉल्ट आयात करूंगा और उसके बाद दिए गए/कब/फिर विधियों तक पहुंच प्राप्त करूंगा:
"ककड़ी" से ककड़ी आयात करें;
ककड़ी। दिया (...);

यह काम नहीं करता है। मुझे वही संदेश मिलता है।
मेरे पास package.json में "टाइप": "मॉड्यूल" है और मेरी बाकी परियोजना मॉड्यूल का उपयोग कर रही है, इसलिए इसे बदलना एक विकल्प नहीं है।

अगर मैं इनमें से किसी एक का उपयोग करता हूं:

import cucumber from '@cucumber/cucumber';
// OR
import { When } from '@cucumber/cucumber';

मुझे मूल पोस्ट के समान त्रुटि संदेश मिलता है।
अगर मैं . में बदल जाता हूँ

const cucumber = require('@cucumber/cucumber');

तब मुझे यह संदेश मिलता है:

इसके बजाय .cjs में समाप्त होने के लिए /some/path/cucumbertest/features/step_definitions.js का नाम बदलें, आयात() का उपयोग करने के लिए आवश्यक कोड बदलें, या प्रोजेक्ट/पैकेज.जेसन से "टाइप": "मॉड्यूल" को हटा दें।

अगर मैं step_definitions.js का नाम बदलकर _eother_ step_definitions.cjs या step_definitions.mjs कर देता हूं, तो इसे अनदेखा कर दिया जाता है और मुझे ककड़ी से सामान्य संदेश मिलते हैं जो मेरे चरणों के लिए स्टब्स बनाने के लिए कहते हैं:

UUUUUU

Failures:

1) Scenario: Empty Payload # spec\cucumber\features\users\create\main.feature:4
   ? When the client creates a POST request to /users
       Undefined. Implement with the following snippet:

         When('the client creates a POST request to \/users', function () {
           // Write code here that turns the phrase above into concrete actions
           return 'pending';
         });

... etc

अगर मैं फ़ाइल को पूरी तरह से हटा देता हूं तो मुझे वही संदेश मिलते हैं, इसलिए इसे स्पष्ट रूप से अनदेखा किया जा रहा है।

समाधान (प्रकार)

अंत में, जिस तरह से मैं "टाइप": "मॉड्यूल" के साथ एक प्रोजेक्ट में चलाने के लिए ककड़ी प्राप्त करने में सक्षम हूं, वह है "टाइप": "मॉड्यूल" के बिना एक अलग specpackage.json बनाना और ककड़ी को spec/node_modules में स्थापित करना

अभी तक यह चालू लगता है। आइए देखें कि कुछ वास्तविक परीक्षण बनाने के बाद क्या यह अभी भी काम कर रहा है।

अनुरक्षकों के लिए: यह मेरा पहली बार ककड़ी का उपयोग कर रहा है, और मुझे यह अब तक पसंद है। हालाँकि, इसने वास्तव में मेरी प्रगति में सेंध लगा दी है। दोपहर को ककड़ी सीखने में खर्च करने के बजाय मैंने इसे डिबगिंग आयात पर खर्च किया। मुझे पता है कि एक पुस्तकालय बनाने की कोशिश करना कितना कष्टप्रद है जो ES6 आयात और CJS दोनों का समर्थन करता है, इसलिए आपको मेरी सहानुभूति है।

एक संभावित समाधान:
यदि आप दूसरी डिस्ट फ़ाइल जेनरेट करते हैं, तो CJS और ES6 बिल्ड दोनों को एक साथ प्रकाशित करना संभव है:

जिला/खीरा.js
जिला/खीरा.मॉड्यूल.जेएस

फिर इस लाइन को package.json में जोड़ें:

"मॉड्यूल": "dist/cucumber.module.js"

यह ES6 आयातों को हल करने के लिए नोड को सक्षम करना चाहिए।

looeee 15 अक्तू॰ 2020

ऐसा करने का एक बेहतर तरीका होना चाहिए। मुझे भी वह समस्या हो रही है, और क्योंकि आयात का उपयोग आम जेएस के साथ नहीं किया जा सकता है, मुझे इसका उपयोग करना होगा
https://nodejs.org/api/esm.html#esm_import_expressions

हर जगह...

क्या कोई ऐसा तरीका है जिससे ककड़ी का झंडा हमें ES का उपयोग करने में सक्षम बनाने में मदद कर सकता है?

jwisbeck 18 जन॰ 2021

इसमें रुचि रखने वाले लोगों के लिए त्वरित एक: जब आप ककड़ी के साथ एक परियोजना में ईएसएम का उपयोग करते हैं, तो क्या आप:

.js एक्सटेंशन और "type":"module"
.mjs एक्सटेंशन का उपयोग करें
कुछ और?

धन्यवाद!

davidjgoss 27 फ़र॰ 2021

अस्पष्टता से बचने के लिए मैं अपनी सभी जावास्क्रिप्ट फ़ाइलों के लिए .mjs और .cjs एक्सटेंशन का उपयोग करने की परंपरा का पालन करता हूं, और इस मामले में भी ऐसा करना मेरी प्राथमिकता होगी। हालांकि, प्रोजेक्ट स्तर पर "टाइप": "मॉड्यूल" सेट करने में कोई बड़ी असुविधा नहीं होगी और अगर यह अधिक उपयोगकर्ताओं के लिए बेहतर समाधान है तो इन्हें .js फाइलों के रूप में छोड़ दें।

adamlacoste 28 फ़र॰ 2021

looeee 28 फ़र॰ 2021

👍3

प्रतिक्रिया के लिए धन्यवाद @adamlacoste @looeee

davidjgoss 7 अप्रैल 2021

@davidjgoss क्या #1589 का विलय होना उस मुद्दे को बंद करने के लिए पर्याप्त है? या हमें कुछ और चाहिए?

aurelien-reeves 19 अप्रैल 2021

कुहनी से हलका धक्का @ ऑरेलियन-रीव्स के लिए धन्यवाद!

@cucumber/cucumber का संस्करण 7.2.0 अब npm पर है, जिसमें ESM के लिए प्रायोगिक समर्थन शामिल है जैसा कि यहां डॉक्स में वर्णित है:
https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#es-modules-experimental-nodejs-12

यदि रुचि रखने वाले लोग इसे आजमा सकते हैं और रिपोर्ट कर सकते हैं कि आपको क्या लगता है तो यह बहुत अच्छा होगा। मैंने यहां एक सुपर न्यूनतम उदाहरण प्रोजेक्ट रखा है:
https://github.com/davidjgoss/cucumber-esm-example

इस मुद्दे को थोड़ी देर के लिए खुला रखने में खुशी हुई, बस एक ही स्थान पर प्रारंभिक प्रतिक्रिया प्राप्त करने के लिए।

davidjgoss 20 अप्रैल 2021

🚀1 🎉1

संदर्भ https://github.com/cucumber/cucumber-js/issues/1646

aurelien-reeves 21 अप्रैल 2021

तो इस परिवर्तन ने तृतीय-पक्ष ढांचे और स्वरूपकों के साथ एक समस्या उत्पन्न की जो require कुछ सामान सीधे (प्रवेश बिंदु के विपरीत)। मैंने 7.2.1 जारी किया है जो मूल रूप से उन लोगों को अनवरोधित करने के लिए 7.1.0 पर वापस आ गया है, और मैं इस कारण को खोदूंगा और देखूंगा कि क्या हम ईएसएम का समर्थन करते हुए इससे बच सकते हैं। इस बीच, यदि यह आपको प्रभावित नहीं करता है, तो अभी भी 7.2.0 प्रयोग करना बाकी है।

davidjgoss 21 अप्रैल 2021

👍1

मैं --esm ध्वज के साथ v7.2.0 एक शॉट देने का प्रयास कर रहा हूं। मैं उस पैकेज के परीक्षणों में टेस्टडबल का उपयोग करता हूं जिसे मैं ईएसएम में बदलने का प्रयास कर रहा हूं।

td.replaceEsm का उपयोग करने के लिए, एक लोडर का उपयोग किया जाना चाहिए जैसे --loader=testdouble । जब मैं लोडर को सीधे ककड़ी क्ली को प्रदान करने का प्रयास करता हूं, तो मुझे निम्न त्रुटि मिलती है:

> cucumber-js test/integration --esm --loader=testdouble

error: unknown option '--loader=testdouble'

चूंकि वह विकल्प उपलब्ध नहीं था, इसलिए मैंने इसके साथ प्रयास किया NODE_OPTIONS :

> NODE_OPTIONS='--loader=testdouble' cucumber-js test/integration --esm

(node:62231) ExperimentalWarning: --experimental-loader is an experimental feature. This feature could change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
internal/process/esm_loader.js:74
    internalBinding('errors').triggerUncaughtException(
                              ^

TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension "" for /path/to/project/node_modules/@cucumber/cucumber/bin/cucumber-js
    at defaultGetFormat (internal/modules/esm/get_format.js:71:15)
    at getFormat (file:///path/to/project/node_modules/quibble/lib/quibble.mjs:65:12)
    at Loader.getFormat (internal/modules/esm/loader.js:104:42)
    at Loader.getModuleJob (internal/modules/esm/loader.js:242:31)
    at async Loader.import (internal/modules/esm/loader.js:176:17)
    at async Object.loadESM (internal/process/esm_loader.js:68:5) {
  code: 'ERR_UNKNOWN_FILE_EXTENSION'
}

संदर्भ के लिए, यह नोड v14.17.0 विरुद्ध था

यह अच्छा होगा यदि यह NODE_OPTIONS दृष्टिकोण के साथ काम करता है, लेकिन आदर्श रूप से --loader विकल्प सीधे क्ली द्वारा समर्थित होगा जैसे कुछ परीक्षण ढांचे का समर्थन करना शुरू हो गया है। कृपया इन दृष्टिकोणों पर अपने अगले संस्करण के साथ विचार करें जो ईएसएम समर्थन तक पहुंचता है :)

क्या लोडर को परिभाषित करने के लिए कोई दृष्टिकोण है कि आप v7.2.0 साथ काम करने की अपेक्षा करेंगे?

travi 19 मई 2021

क्या यह पृष्ठ उपयोगी था?

0 / 5 - 0 रेटिंग्स