Adding BeforeAll and AfterAll hooks #1114

VidhiRambhia · 2023-11-06T05:44:36Z

This PR adds BeforeAll(..) and AfterAll(..) hooks, fixes #758

badeball · 2023-11-08T10:12:53Z

features/issues/758.feature

+      })
+      """
+    When I run cypress
+    Then it passes


This test can be moved and incorperated into features/hooks_ordering.feature. Issue-specific tests are only for behavior that is otherwise hard to describe.

badeball · 2023-11-08T10:14:00Z

lib/browser-runtime.ts

@@ -18,7 +18,7 @@ import DataTable from "./data_table";

 import {
  assignRegistry,
-  freeRegistry,
+  freeRegistry, getRegistry,


You should run all tests, this will reveal this as a problem (unused variable and incorrect formatting).

$ npm run test

Got it, will remove this

badeball · 2023-11-08T10:15:09Z

lib/browser-runtime.ts

@@ -775,6 +780,31 @@ function beforeHandler(context: CompositionContext) {
  taskSpecEnvelopes(context);
 }

+function beforeAllHandler(this: Mocha.Context, context: CompositionContext) {


This method's content can be moved into beforeHandler(..).

Refactored it

badeball · 2023-11-08T10:15:22Z

lib/browser-runtime.ts

+  const { registry } = context;
+  let beforeAllHooks = registry.resolveBeforeAllHooks();
+  for(const beforeAllHook of beforeAllHooks) {
+      if (beforeAllHook) {


This check seems unnecessary.

Yes, it's redundant. Removing it

badeball · 2023-11-08T10:18:56Z

lib/browser-runtime.ts

+          .then((start) => {
+            const end = createTimestamp();
+          });
+      }


Wrapping runStepWithLogGroup in order to obtain start- & end-time is only necessary when these values are actually used for something and this isn't the case here. Thus, you can replace

cy.then(() => { const start = createTimestamp(); return cy.wrap(start, { log: false }); }) .then((start) => { runStepWithLogGroup({ fn: () => registry.runHook(this, hook), keyword: "BeforeAll" }); return cy.wrap(start, { log: false }); }) .then((start) => { const end = createTimestamp(); });

.. with

runStepWithLogGroup({ fn: () => registry.runHook(this, hook), keyword: "BeforeAll" });

I see. Made this change

badeball · 2023-11-08T10:19:07Z

lib/browser-runtime.ts

+        .then((start) => {
+          const end = createTimestamp();
+        });
+    }


Same goes for here.

badeball · 2023-11-08T10:20:45Z

lib/entrypoint-browser.ts

@@ -127,6 +127,28 @@ function defineAfterStep(
  }
 }

+function defineBeforeAll(fn: IHookBody): void;
+function defineBeforeAll(
+  maybeFn?: IHookBody


The optionality and function overloading here is unecessary, as there's only one way to invoke this method.

Makes sense, I'll change this here and in other places too

badeball · 2023-11-08T10:20:55Z

lib/entrypoint-browser.ts

+
+function defineAfterAll(fn: IHookBody): void;
+function defineAfterAll(
+  maybeFn?: IHookBody


Same goes for here.

badeball · 2023-11-08T10:21:12Z

lib/entrypoint-node.ts

+export function BeforeAll(fn: IStepHookBody): void;
+export function BeforeAll(
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  maybeFn?: IStepHookBody


badeball · 2023-11-08T10:21:18Z

lib/entrypoint-node.ts

+export function AfterAll(fn: IStepHookBody): void;
+export function AfterAll(
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  maybeFn?: IStepHookBody


Made the change

badeball · 2023-11-08T10:21:32Z

lib/registry.ts

@@ -101,7 +101,6 @@ export class Registry {
    this.runStepDefininition = this.runStepDefininition.bind(this);
    this.defineParameterType = this.defineParameterType.bind(this);
    this.defineBefore = this.defineBefore.bind(this);
-    this.defineAfter = this.defineAfter.bind(this);


This is probably not right.

Deleted this by mistake, reverting it back

badeball · 2023-11-08T10:22:05Z

test-d/entrypoint-node.test-d.ts

@@ -25,6 +25,8 @@ import {
  After,
  BeforeStep,
  AfterStep,
+  BeforeAll,
+  AfterAll,


You can add the same tests here, as you have in test-d/entrypoint-browser.test-d.ts.

This primarily renames a bunch of stuff to more clearly differentiate between the three types of hooks that exists now, namely: - run hooks (BeforeAll, AfterAll) - case hooks (Before, After) - step hooks (BeforeStep, AfterStep) The naming convention comes from cucumber-js [1]. Additionally, the order of AfterAll is reversed before execution. Lastly, documentation has been updated. [1] https://github.com/cucumber/cucumber-js/blob/v10.0.0/src/support_code_library_builder/index.ts#L72-L77

badeball · 2023-11-08T18:53:41Z

Excellent, thank you. I did some clean up in 61623bc, some of that stuff was just easier to do myself than to explain.

VidhiRambhia · 2023-11-08T19:01:20Z

Thank you, @badeball!
Please let me know if I can contribute to some other issue

VidhiRambhia and others added 3 commits October 25, 2023 23:36

Adding a feature file

ad66c3d

Adding BeforeAll and AfterAll hooks

ba4dc23

Merge branch 'badeball:master' into master

4fee78f

VidhiRambhia mentioned this pull request Nov 6, 2023

Add 'BeforeAll' hook #758

Closed

3 tasks

VidhiRambhia added 3 commits November 5, 2023 23:50

Adding BeforeAll and AfterAll hooks

d9a2b69

Merge remote-tracking branch 'origin/master'

3e9a31c

Reverting a redundant change

eaebfe5

VidhiRambhia marked this pull request as ready for review November 7, 2023 15:44

badeball reviewed Nov 8, 2023

View reviewed changes

lib/browser-runtime.ts Outdated

.then((start) => {

const end = createTimestamp();

});

}

Copy link

Owner

badeball Nov 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same goes for here.

badeball reviewed Nov 8, 2023

View reviewed changes

Addressing comments

186e2b6

badeball merged commit c5f4c8a into badeball:master Nov 8, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding BeforeAll and AfterAll hooks #1114

Adding BeforeAll and AfterAll hooks #1114

VidhiRambhia commented Nov 6, 2023 •

edited

Loading

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

badeball Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023

VidhiRambhia Nov 8, 2023

badeball Nov 8, 2023 •

edited

Loading

badeball commented Nov 8, 2023

VidhiRambhia commented Nov 8, 2023

Adding BeforeAll and AfterAll hooks #1114

Adding BeforeAll and AfterAll hooks #1114

Conversation

VidhiRambhia commented Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

badeball Nov 8, 2023 • edited Loading

Choose a reason for hiding this comment

badeball commented Nov 8, 2023

VidhiRambhia commented Nov 8, 2023

VidhiRambhia commented Nov 6, 2023 •

edited

Loading

badeball Nov 8, 2023 •

edited

Loading