Skip to content

Commit 70a7512

Browse files
norareidyalcaeusrustagir
authored
PHP Comprehensive Coverage (#282)
* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <andreas.braun@mongodb.com> Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com>
1 parent be5f26f commit 70a7512

File tree

138 files changed

+3943
-2163
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+3943
-2163
lines changed

‎.github/actions/setup/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ runs:
2121
with:
2222
php-version: ${{ inputs.php-version }}
2323
extensions: "mongodb-${{ inputs.driver-version }}"
24-
key: "extcache-v1"
24+
key: "extcache-${{ inputs.driver-version }}"
2525

2626
- name: Cache extensions
2727
uses: actions/cache@v4

‎.github/workflows/add-redirects.yml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: Verify Redirects
2+
3+
on:
4+
pull_request_target:
5+
6+
jobs:
7+
verify-redirects:
8+
name: Verifying Redirects
9+
runs-on: ubuntu-latest
10+
env:
11+
REDIRECTS_FILE: "pr/config/redirects"
12+
permissions:
13+
pull-requests: write
14+
steps:
15+
- name: Check Out Base Branch
16+
uses: actions/checkout@v4
17+
18+
- name: Checkout PR Head Branch
19+
uses: actions/checkout@v4
20+
with:
21+
token: ${{ secrets.GITHUB_TOKEN }}
22+
ref: ${{ github.event.pull_request.head.ref }}
23+
repository: ${{ github.event.pull_request.head.repo.full_name }}
24+
path: pr
25+
26+
- name: Get Changed Files
27+
id: changed-files
28+
uses: tj-actions/changed-files@c65cd883420fd2eb864698a825fc4162dd94482c
29+
with:
30+
include_all_old_new_renamed_files: true
31+
32+
- name: Find Missing Redirects for Renamed Files
33+
id: renamed-files
34+
if: steps.changed-files.outputs.renamed_files_count > 0
35+
env:
36+
RENAMED_FILES: ${{ steps.changed-files.outputs.all_old_new_renamed_files }}
37+
run: |
38+
renamed_redirects=""
39+
40+
for file in $RENAMED_FILES; do
41+
42+
# only run for .txt files
43+
if [[ ! "$file" == *.txt ]]; then
44+
continue
45+
fi
46+
47+
# format old and new URLs
48+
old=$(echo "$file" | cut -d',' -f1)
49+
old="${old#source}"
50+
old="${old%.txt}"
51+
new=$(echo "$file" | cut -d',' -f2)
52+
new="${new#source}"
53+
new="${new%.txt}"
54+
55+
redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}'"$new"'/'
56+
57+
# if redirect not already in file, add to string to add to PR description
58+
if ! grep -q "$redirect" $REDIRECTS_FILE; then
59+
renamed_redirects+="<li>[&lt;v&gt;-*]: $redirect</li>"
60+
fi
61+
done
62+
63+
echo "redirects=${renamed_redirects}" >> "$GITHUB_OUTPUT"
64+
65+
- name: Find Missing Redirects for Deleted Files
66+
id: deleted-files
67+
if: steps.changed-files.outputs.deleted_files_count > 0
68+
env:
69+
DELETED_FILES: ${{ steps.changed-files.outputs.deleted_files }}
70+
run: |
71+
deleted_redirects=""
72+
73+
for file in $DELETED_FILES; do
74+
75+
# only run for .txt files
76+
if [[ ! "$file" == *.txt ]]; then
77+
continue
78+
fi
79+
80+
# format old URL
81+
old=$(echo "$file" | cut -d',' -f1)
82+
old="${old#source}"
83+
old="${old%.txt}"
84+
85+
redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}/'
86+
87+
# escape special characters before searching for string
88+
escaped_redirect=$(printf '%s\n' "$redirect" | sed 's/[[*${}|\\]/\\&/g')
89+
90+
# if redirect not already in file, add to string to add to PR description
91+
if ! grep -qE "${escaped_redirect}$" $REDIRECTS_FILE; then
92+
deleted_redirects+="<li>[&lt;v&gt;-*]: $redirect</li>"
93+
fi
94+
done
95+
96+
echo "redirects=${deleted_redirects}" >> "$GITHUB_OUTPUT"
97+
98+
- name: Build Redirect HTML
99+
id: build-redirect-html
100+
env:
101+
RENAMED_REDIRECTS: ${{ steps.renamed-files.outputs.redirects }}
102+
DELETED_REDIRECTS: ${{ steps.deleted-files.outputs.redirects }}
103+
run: |
104+
redirect_html=''
105+
combined_redirects="${RENAMED_REDIRECTS}${DELETED_REDIRECTS}"
106+
107+
if [ -n "$combined_redirects" ]; then
108+
redirect_html="<h3>Suggested redirects for moved, renamed, and deleted files:</h3><p><em>Replace &lt;v&gt; with the earliest backport target version</p></em>$combined_redirects"
109+
fi
110+
111+
echo "redirect_html=${redirect_html}" >> "$GITHUB_OUTPUT"
112+
113+
- name: Update PR Description
114+
uses: MongoCaleb/pr-description-action@4bdfe35b98f64532b419ad20b350a92546cd3aa1
115+
with:
116+
regex: "- \\[( |x)\\] Did you add redirects\\?.*"
117+
appendContentOnMatchOnly: false
118+
regexFlags: is
119+
content: "- [ ] Did you add redirects?\n ${{ steps.build-redirect-html.outputs.redirect_html }}"
120+
token: ${{ secrets.GITHUB_TOKEN }}
121+
122+
- name: Check for duplicates in redirects file
123+
run: |
124+
if [[ -f "$REDIRECTS_FILE" ]]; then
125+
duplicates=$(sort "$REDIRECTS_FILE" | uniq -d)
126+
if [[ -n "$duplicates" ]]; then
127+
echo "Duplicate lines found in $REDIRECTS_FILE:"
128+
echo "$duplicates"
129+
exit 1 # error
130+
fi
131+
else
132+
"Redirects file doesn't exist. Skipping duplicate check."
133+
fi

‎.github/workflows/coding-standards.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
paths:
66
- "source/**/*.php"
77
- ".github/workflows/*.yml"
8+
- ".github/actions/**"
89

910
env:
1011
PHP_VERSION: "8.2"

‎.github/workflows/static-analysis.yml‎

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎composer/composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
"dealerdirect/phpcodesniffer-composer-installer": true
1616
}
1717
}
18-
}
18+
}

‎config/redirects‎

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ raw: ${prefix}/stable -> ${base}/current/
2525
# redirects in standardized docs
2626
[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/
2727
[v1.20-*]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/${version}/connect/
28-
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring/cluster-monitoring/
28+
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring-logging/monitoring/
2929
[v1.20-*]: ${prefix}/${version}/tutorial/crud/ -> ${base}/${version}/read/
3030
[v1.20-*]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/${version}/data-formats/codecs/
3131
[v1.20-*]: ${prefix}/${version}/tutorial/collation/ -> ${base}/${version}/
@@ -45,7 +45,7 @@ raw: ${prefix}/stable -> ${base}/current/
4545
# note: this mapping does not account for all of the new pages
4646
[*-v1.19]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/v1.x/get-started/
4747
[*-v1.19]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/v1.x/connect/
48-
[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring/cluster-monitoring/
48+
[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring-logging/monitoring/
4949
[*-v1.19]: ${prefix}/${version}/tutorial/crud/ -> ${base}/v1.x/read/
5050
[*-v1.19]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/v1.x/data-formats/codecs/
5151
[*-v1.19]: ${prefix}/${version}/tutorial/collation/ -> ${base}/v1.x/
@@ -59,4 +59,38 @@ raw: ${prefix}/stable -> ${base}/current/
5959
[*-v1.19]: ${prefix}/${version}/tutorial/example-data/ -> ${base}/v1.x/
6060
[*-v1.19]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/v1.x/data-formats/modeling-bson-data/
6161
[*-v1.19]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/v1.x/stable-api/
62-
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/
62+
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/
63+
64+
# comprehensive coverage redirects
65+
[*-master]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/
66+
[*-master]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/connect/aws-lambda/
67+
[*-master]: ${prefix}/${version}/connect/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/
68+
[*-master]: ${prefix}/${version}/builders/ -> ${base}/${version}/crud/builders/
69+
[*-master]: ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/
70+
[*-master]: ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/
71+
[*-master]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/
72+
[*-master]: ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/
73+
[*-master]: ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count/
74+
[*-master]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/crud/query/cursor/
75+
[*-master]: ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct/
76+
[*-master]: ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project/
77+
[*-master]: ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/retrieve/
78+
[*-master]: ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-a-query/
79+
[*-master]: ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/
80+
[*-master]: ${prefix}/${version}/read-write-pref/ -> ${base}/${version}/crud/read-write-pref/
81+
[*-master]: ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/replace/
82+
[*-master]: ${prefix}/${version}/write/transaction/ -> ${base}/${version}/crud/transaction/
83+
[*-master]: ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/
84+
[*-master]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/
85+
[*-master]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/
86+
[*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/
87+
[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/monitoring/
88+
[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/
89+
[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/
90+
[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/
91+
[*-master]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
92+
[*-master]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/
93+
[*-master]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/monitoring-logging/
94+
[*-master]: ${prefix}/${version}/read/ -> ${base}/${version}/crud/
95+
[*-master]: ${prefix}/${version}/write/ -> ${base}/${version}/crud/
96+
[*-master]: ${prefix}/${version}/faq/ -> ${base}/${version}/

‎phpcs.xml.dist‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<?xml version="1.0"?>
2+
<ruleset>
3+
<arg name="basepath" value="." />
4+
<arg name="extensions" value="php" />
5+
<arg name="parallel" value="80" />
6+
<arg name="cache" value=".phpcs-cache" />
7+
<arg name="colors" />
8+
9+
<!-- Ignore warnings (n), show progress of the run (p), and show sniff names (s) -->
10+
<arg value="nps"/>
11+
12+
<file>source</file>
13+
14+
<!-- Target minimum supported PHP version -->
15+
<config name="php_version" value="80100"/>
16+
17+
<!-- ****************************************** -->
18+
<!-- Import rules from doctrine/coding-standard -->
19+
<!-- ****************************************** -->
20+
<rule ref="Doctrine">
21+
<!-- ******************************************** -->
22+
<!-- Exclude sniffs we simply don't want for docs -->
23+
<!-- ******************************************** -->
24+
<exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace" />
25+
<exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly" />
26+
<exclude name="Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps" />
27+
<!-- Results in false positives with comments used to denote include blocks -->
28+
<exclude name="SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing.IncorrectLinesCountAfterControlStructure" />
29+
<exclude name="Squiz.Classes.ClassFileName.NoMatch" />
30+
<!-- Results in false positives with comments used to denote include blocks before functions -->
31+
<exclude name="Squiz.Commenting.FunctionComment.WrongStyle" />
32+
<!-- Results in false positives with comments used to denote include blocks after functions -->
33+
<exclude name="Squiz.WhiteSpace.FunctionSpacing.After" />
34+
<!-- The following three excludes allow for more compact single-item array declarations -->
35+
<exclude name="Squiz.Arrays.ArrayDeclaration.IndexNoNewline" />
36+
<exclude name="Generic.Arrays.ArrayIndent.CloseBraceNotNewLine" />
37+
<exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNewLine" />
38+
39+
<!-- *********************************** -->
40+
<!-- Exclude sniffs that cause BC breaks -->
41+
<!-- *********************************** -->
42+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming" />
43+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming" />
44+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming" />
45+
<exclude name="SlevomatCodingStandard.Classes.SuperfluousTraitNaming" />
46+
47+
<!-- Can cause subtle BC breaks -->
48+
<exclude name="SlevomatCodingStandard.TypeHints.DeclareStrictTypes" />
49+
50+
51+
<!-- **************************************** -->
52+
<!-- Exclude sniffs that force unwanted style -->
53+
<!-- **************************************** -->
54+
<exclude name="Generic.Formatting.MultipleStatementAlignment" />
55+
<exclude name="Squiz.Commenting.FunctionComment.ThrowsNoFullStop" />
56+
<exclude name="SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.DisallowedShortNullable" />
57+
58+
<!-- Keep long typehints (for now) -->
59+
<exclude name="PSR12.Keywords.ShortFormTypeKeywords" />
60+
<exclude name="SlevomatCodingStandard.PHP.TypeCast.InvalidCastUsed" />
61+
<exclude name="SlevomatCodingStandard.TypeHints.LongTypeHints" />
62+
63+
64+
<!-- ************************************************ -->
65+
<!-- Exclude sniffs that may cause functional changes -->
66+
<!-- ************************************************ -->
67+
<exclude name="Generic.PHP.ForbiddenFunctions.FoundWithAlternative" />
68+
<exclude name="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison" />
69+
<exclude name="SlevomatCodingStandard.ControlStructures.EarlyExit" />
70+
<exclude name="SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn" />
71+
<exclude name="SlevomatCodingStandard.Functions.StaticClosure" />
72+
<exclude name="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
73+
<exclude name="SlevomatCodingStandard.Operators.DisallowEqualOperators" />
74+
75+
76+
<!-- ********************************************************* -->
77+
<!-- Exclude sniffs that cause a huge diff - enable separately -->
78+
<!-- ********************************************************* -->
79+
<exclude name="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectAnnotationsGroup" />
80+
81+
82+
<!-- ********************* -->
83+
<!-- Exclude broken sniffs -->
84+
<!-- ********************* -->
85+
86+
<!-- Sniff currently broken when casting arrays, see https://github.com/squizlabs/PHP_CodeSniffer/issues/2937#issuecomment-615498860 -->
87+
<exclude name="Squiz.Arrays.ArrayDeclaration.ValueNoNewline" />
88+
89+
<!-- Disable forbidden annotation sniff as excluding @api from the list doesn't work -->
90+
<exclude name="SlevomatCodingStandard.Commenting.ForbiddenAnnotations.AnnotationForbidden" />
91+
</rule>
92+
93+
94+
<!-- **************************************** -->
95+
<!-- Enable rules not enforced by Doctrine CS -->
96+
<!-- **************************************** -->
97+
98+
<!-- Require arrow functions where possible -->
99+
<rule ref="SlevomatCodingStandard.Functions.RequireArrowFunction"/>
100+
101+
102+
<!-- ****************************************************** -->
103+
<!-- Don't require annotations to specify traversable types -->
104+
<!-- ****************************************************** -->
105+
<rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
106+
<exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification" />
107+
</rule>
108+
<rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
109+
<exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingTraversableTypeHintSpecification" />
110+
</rule>
111+
<rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
112+
<exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification" />
113+
</rule>
114+
115+
<rule ref="Generic.Files.InlineHTML.Found">
116+
<exclude-pattern>source/includes/aws-lambda/index.php</exclude-pattern>
117+
</rule>
118+
119+
</ruleset>

0 commit comments

Comments
 (0)