fix: pozil review (#5)

Author: scolladon

.forceignore

@@ -1,8 +1,15 @@
+# .forceignore v2
 # List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
 # More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
 #
 
+# Standard metadata
 package.xml
+**/appMenus/**
+**/appSwitcher/**
+**/objectTranslations/**
+**/profiles/**
+**/settings/**
 
 # LWC configuration files
 **/jsconfig.json

.github/workflows/main.yml

@@ -1,38 +1,20 @@
-name: CI
+name: main
 
 on:
-  pull_request:
+  push:
     branches: [master]
 
 jobs:
-  formatting-and-linting:
-    runs-on: ubuntu-latest
-    steps:
-      - name: "Checkout source code"
-        uses: actions/checkout@v2
-
-      - uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-
-      - name: "Install npm dependencies"
-        run: npm install
 
-      - name: "Code formatting verification with Prettier"
-        run: npm run prettier:verify
-
-      - name: Install PMD
-        run: wget https://github.com/pmd/pmd/releases/download/pmd_releases%2F6.22.0/pmd-bin-6.22.0.zip && unzip pmd-bin-6.22.0.zip
-
-      - name: Execute PMD
-        run: pmd-bin-6.22.0/bin/run.sh pmd -minimumpriority 2 -d chain -R apex-ruleset.xml -f text -l apex
-
-  ci-build:
+  build:
     runs-on: ubuntu-latest
     steps:
+      - name: Set environment variables
+        run: |
+            echo "SFDX_DISABLE_AUTOUPDATE=true" >> $GITHUB_ENV
+            echo "SFDX_DISABLE_SOURCE_MEMBER_POLLING=true" >> $GITHUB_ENV
+            echo "SFDX_DISABLE_TELEMETRY=true" >> $GITHUB_ENV
+            
       - name: Install Salesforce CLI
         run: |
           wget https://developer.salesforce.com/media/salesforce-cli/sfdx-linux-amd64.tar.xz
@@ -57,7 +39,12 @@ jobs:
         run: 'sfdx force:source:push'
 
       - name: 'Run Apex tests'
-        run: npm run test:coverage
+        run: sfdx force:apex:test:run -c -r human -d ./tests/apex -w 20
+        
+      - name: 'Upload code coverage for Apex to Codecov.io'
+        uses: codecov/[email protected]
+        with:
+            flags: Apex
 
       - name: 'Delete scratch org'
         if: always()

.github/workflows/pull-request.yml

@@ -0,0 +1,84 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  formatting-and-linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout source code"
+        uses: actions/checkout@v2
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Set environment variables
+        run: |
+            echo "SFDX_DISABLE_AUTOUPDATE=true" >> $GITHUB_ENV
+            echo "SFDX_DISABLE_TELEMETRY=true" >> $GITHUB_ENV
+      
+      - name: Install Salesforce CLI
+        run: |
+          wget https://developer.salesforce.com/media/salesforce-cli/sfdx-linux-amd64.tar.xz
+          mkdir sfdx-cli
+          tar xJf sfdx-linux-amd64.tar.xz -C sfdx-cli --strip-components 1
+          ./sfdx-cli/install
+
+      - name: "Install npm dependencies"
+        run: npm install
+
+      - name: "Code formatting verification with Prettier"
+        run: npm run prettier:verify
+
+      - name: Execute Static Analysis
+        run: npm run lint
+
+  ci-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set environment variables
+        run: |
+            echo "SFDX_DISABLE_AUTOUPDATE=true" >> $GITHUB_ENV
+            echo "SFDX_DISABLE_SOURCE_MEMBER_POLLING=true" >> $GITHUB_ENV
+            echo "SFDX_DISABLE_TELEMETRY=true" >> $GITHUB_ENV
+
+      - name: Install Salesforce CLI
+        run: |
+          wget https://developer.salesforce.com/media/salesforce-cli/sfdx-linux-amd64.tar.xz
+          mkdir sfdx-cli
+          tar xJf sfdx-linux-amd64.tar.xz -C sfdx-cli --strip-components 1
+          ./sfdx-cli/install
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: "Populate auth file with CI_URL secret"
+        shell: bash
+        run: "echo ${{ secrets.CI_URL}} > ./CI_URL.txt"
+
+      - name: "Authenticate CI Sandbox"
+        run: "sfdx force:auth:sfdxurl:store -f ./CI_URL.txt -a ci -d"
+
+      - name: 'Create scratch org'
+        run: 'sfdx force:org:create -f config/project-scratch-def.json -a scratch-org -s -d 1'
+
+      - name: 'Push source to scratch org'
+        run: 'sfdx force:source:push'
+
+      - name: 'Run Apex tests'
+        run: npm run test:coverage
+        
+      - name: 'Upload code coverage for Apex to Codecov.io'
+        uses: codecov/[email protected]
+        with:
+            flags: Apex
+
+      - name: 'Delete scratch org'
+        if: always()
+        run: 'sfdx force:org:delete -p -u scratch-org'

.lintstagedrc

@@ -1,5 +1,8 @@
 {
     "**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,yaml,yml}": [
       "prettier --write"
+    ],
+    "**/classes/*.cls": [
+      "sfdx scanner:run -v -f table -c 'Async-Linkable' -t "
     ]
 }

.prettierignore

@@ -4,4 +4,5 @@
 coverage/
 tests/
 sfdx-project.json
-config/project-scratch-def.json
+config/project-scratch-def.json
+sfdx-cli

README.md

@@ -1,67 +1,79 @@
-## Apex AsyncLinkable
+## Apex AsyncLinkable ![Build](https://github.com/scolladon/apex-async-linkable/actions/workflows/main.yml/badge.svg) [![codecov](https://codecov.io/gh/scolladon/apex-async-linkable/branch/master/graph/badge.svg?token=DFHDV3OCIS)](https://codecov.io/gh/scolladon/apex-async-linkable)
 
 This library provides all the classes required to chain all kind of Async jobs.
 
 ## Installation
 
 ```bash
-$ sfdx force:source:deploy -p path/to/source
+$ sfdx force:source:deploy -p chain/src/lib
 ```
 
 ## Usage
 
-Create a class and extend the type of the AsyncLinkable class you require.\
-Your class can have its own constructors and its own attributes of course !\
-Respect the interface contract and override the job method.\
-You need to override the start method also for the BatchLink and ScheduleBatchLink class\
-The job method will contains your business logic. It can access the private attributes of your class (and the protected ones of the base class).\
-If you need some extra interface to make you're code work, it is up to you to add them (Database.Stateful, Database.AllowsCallouts, etc).\
-You're ready to chain !\
-You do not need to override another method except if you really know what you're doing\
+1. Create a class and extend the type of the `[AsyncLinkable](https://github.com/scolladon/apex-async-linkable/blob/master/chain/src/lib/classes/AsyncLinkable.cls)` class you require.
+   _Your class can have its own constructors and its own attributes of course !_
+2. Respect the interface contract and override the `job` method.
+   _`start` method must also be overridden for the BatchLink and ScheduleBatchLink class_
+
+The `job` method will contains your business logic. It can access the private attributes of your class (and the protected ones of the base class).
+
+If you need some extra interface to make you're code work, it is up to you to add them (`Database.Stateful`, `Database.AllowsCallouts`, etc).
+
+You're ready to chain apex asynchronous process!
+
+Example for Batchable:
 
 ```apex
 // Subclass BatchLink for example
 public class BatchLink_EXAMPLE extends BatchLink {
-  public override Database.QueryLocator start(Database.BatchLinkableContext bc) {
+  public override Database.QueryLocator start(
+    Database.BatchLinkableContext bc
+  ) {
     return Database.getQueryLocator('select id from account limit 1');
   }
 
-  public BatchLink_EXAMPLE(){
+  public BatchLink_EXAMPLE() {
     super();
   }
 
   protected override void job() {
     System.Debug('BatchLink_EXAMPLE');
   }
 }
+```
+
+Example for Queue:
 
+```apex
 //Subclass QueueLink for example
 public class QueueLink_EXAMPLE extends QueueLink {
-
-  public QueueLink_EXAMPLE(){
+  public QueueLink_EXAMPLE() {
     super();
   }
 
   protected override void job() {
     System.Debug('BatchLink_EXAMPLE');
   }
 }
+```
 
+Example chaining `BatchLink_EXAMPLE` and `QueueLink_EXAMPLE`;
+
+```apex
 // Chain both and execute them
 public class Service {
   public static void doService() {
-    AsyncLinkable aChain = new BatchLink_EXAMPLE();
-    aChain.Add(new QueueLink_EXAMPLE());
-
-    aChain.startChain();
+    ChainManager.instance
+      .add(new BatchLink_EXAMPLE())
+      .add(new QueueLink_EXAMPLE())
+      .startChain();
   }
 }
 ```
 
 ## Improvement
 
 Implement sub class allowing to handle BatchLink and ScheduleBatchLink with iterable in addition of QueryLocator\
-Allow to benefit from [this pilot](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_enhanced_FutureLink_overview.htm) for the FutureLink class
 
 ## Versioning
 

apex-ruleset.xml

@@ -2,7 +2,7 @@
 <ruleset
   xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  name="Custom Apex Rules"
+  name="Async-Linkable"
   xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd"
 >
     <description>Custom Ruleset to use with Apex PMD</description>

chain/src/lib/classes/AsyncLinkIterable.cls

@@ -0,0 +1,35 @@
+public inherited sharing class AsyncLinkIterable implements Iterable<AsyncLinkable> {
+  public AsyncLinkable link { get; private set; }
+  public AsyncLinkIterable(final AsyncLinkable link) {
+    this.link = link;
+  }
+
+  public Iterator<AsyncLinkable> iterator() {
+    return new AsyncLinkIterator(this);
+  }
+
+  public inherited sharing class AsyncLinkIterator implements Iterator<AsyncLinkable> {
+    private AsyncLinkIterable linkIterable;
+    private Boolean hasStarted;
+
+    private AsyncLinkIterator(AsyncLinkIterable linkIterable) {
+      this.linkIterable = linkIterable;
+      this.hasStarted = false;
+    }
+
+    public Boolean hasNext() {
+      return !hasStarted
+        ? this.linkIterable?.link != null
+        : this.linkIterable?.link?.nextLink != null;
+    }
+
+    public AsyncLinkable next() {
+      if (!this.hasStarted) {
+        this.hasStarted = true;
+        return this.linkIterable.link;
+      }
+      this.linkIterable.link = this.linkIterable?.link?.nextLink;
+      return this.linkIterable?.link;
+    }
+  }
+}

chain/src/lib/classes/AsyncLinkIterable.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>52.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

chain/src/lib/classes/AsyncLinkable.cls

@@ -1,5 +1,5 @@
 public inherited sharing abstract class AsyncLinkable {
-  protected AsyncLinkable nextLink;
+  public AsyncLinkable nextLink { get; private set; }
   protected boolean canBreak;
   protected String internalExecutor;
 
@@ -27,14 +27,6 @@ public inherited sharing abstract class AsyncLinkable {
     this.nextLink = link;
   }
 
-  public virtual AsyncLinkable getNext() {
-    return this.nextLink;
-  }
-
-  public virtual Boolean hasNext() {
-    return this.getNext() != null;
-  }
-
   public virtual void accept(Visitor aVisitor) {
     aVisitor.visit(this);
   }