Optimize the GetSheetDimension function by parse worksheet XML in stream mode (#2188)

Author: Neugls

sheet.go

@@ -2122,12 +2122,44 @@ func (f *File) SetSheetDimension(sheet, rangeRef string) error {
 // GetSheetDimension provides the method to get the used range of the worksheet.
 func (f *File) GetSheetDimension(sheet string) (string, error) {
 	var ref string
-	ws, err := f.workSheetReader(sheet)
-	if err != nil {
+	if err := checkSheetName(sheet); err != nil {
 		return ref, err
 	}
-	if ws.Dimension != nil {
-		ref = ws.Dimension.Ref
+	name, ok := f.getSheetXMLPath(sheet)
+	if !ok {
+		return ref, ErrSheetNotExist{sheet}
+	}
+	if worksheet, ok := f.Sheet.Load(name); ok && worksheet != nil {
+		ws := worksheet.(*xlsxWorksheet)
+		if ws.Dimension != nil {
+			ref = ws.Dimension.Ref
+		}
+		return ref, nil
+	}
+	needClose, decoder, tempFile, err := f.xmlDecoder(name)
+	if needClose && err == nil {
+		defer func() {
+			err = tempFile.Close()
+		}()
+	}
+	for {
+		token, _ := decoder.Token()
+		if token == nil {
+			break
+		}
+		switch xmlElement := token.(type) {
+		case xml.StartElement:
+			if xmlElement.Name.Local == "dimension" {
+				for _, attr := range xmlElement.Attr {
+					if attr.Name.Local == "ref" {
+						return attr.Value, err
+					}
+				}
+			}
+			if xmlElement.Name.Local == "sheetData" {
+				return ref, err
+			}
+		}
 	}
 	return ref, err
 }

sheet_test.go

@@ -826,6 +826,36 @@ func TestSheetDimension(t *testing.T) {
 	dimension, err = f.GetSheetDimension("SheetN")
 	assert.Empty(t, dimension)
 	assert.EqualError(t, err, "sheet SheetN does not exist")
+
+	// Test get the worksheet dimension with blank worksheet name
+	dimension, err = f.GetSheetDimension("")
+	assert.Empty(t, dimension)
+	assert.Equal(t, err, ErrSheetNameBlank)
+
+	// Test get the worksheet dimension with in mode
+	f, err = OpenFile(filepath.Join("test", "Book1.xlsx"), Options{UnzipXMLSizeLimit: 128})
+	assert.NoError(t, err)
+	dimension, err = f.GetSheetDimension("Sheet1")
+	assert.Equal(t, "A19:D22", dimension)
+	assert.NoError(t, err)
+	assert.NoError(t, f.Close())
+
+	// Test get the worksheet dimension in stream mode without dimension element
+	f, err = OpenFile(filepath.Join("test", "Book1.xlsx"), Options{UnzipXMLSizeLimit: 128})
+	assert.NoError(t, err)
+	tempFile, ok := f.tempFiles.Load("xl/worksheets/sheet1.xml")
+	assert.True(t, ok)
+	assert.NoError(t, os.WriteFile(tempFile.(string), fmt.Appendf(nil, `<worksheet xmlns="%s"><sheetData/></worksheet>`, NameSpaceSpreadSheet.Value), 0o644))
+	dimension, err = f.GetSheetDimension("Sheet1")
+	assert.NoError(t, err)
+	assert.Empty(t, dimension)
+
+	// Test get the worksheet dimension in stream mode without sheetData element
+	assert.NoError(t, os.WriteFile(tempFile.(string), fmt.Appendf(nil, `<worksheet xmlns="%s"></worksheet>`, NameSpaceSpreadSheet.Value), 0o644))
+	dimension, err = f.GetSheetDimension("Sheet1")
+	assert.NoError(t, err)
+	assert.Empty(t, dimension)
+	assert.NoError(t, f.Close())
 }
 
 func TestAddIgnoredErrors(t *testing.T) {